<?php 
///////////////////////////////////////////////////////////////////////////////////////////////////////
//  这个文件是 JCAT PHP框架的一部，该项目和此文件 均遵循 GNU 自由软件协议
// 
//  Copyleft 2008 JeCat.cn(http://team.JeCat.cn)
//
//
//  JCAT PHP框架 的正式全名是：Jellicle Cat PHP Framework。
//  “Jellicle Cat”出自 Andrew Lloyd Webber的音乐剧《猫》（《Prologue:Jellicle Songs for Jellicle Cats》）。
//  JCAT 是一个开源项目，它像音乐剧中的猫一样自由，你可以毫无顾忌地使用JCAT PHP框架。
//  JCAT 由中国团队开发维护，是一个国际性的项目。
//  正在使用的这个版本是：0.3.2 / SVN信息：$Id: class.JCAT_Document.php 1119 2008-10-25 03:55:26Z alee $
//
//
//
//  相关的链接：
//    [主页] http://jcat.JeCat.cn
//    [HTTP下载] http://jcat.JeCat.cn/download
//    [在线文档] http://jcat.JeCat.cn/document
//    [社区] http://jj.jecat.cn/forum-7-1.html
//  不很相关：
//    [MP3] http://www.google.cn/search?q=jellicle+songs+for+jellicle+cats+Andrew+Lloyd+Webber
//    [VCD/DVD] http://www.google.cn/search?q=CAT+Andrew+Lloyd+Webber+video
//
///////////////////////////////////////////////////////////////////////////////////////////////////////
/*-- Project Introduce --*/

class JCAT_Request
{
	/**
	 * Description
	 *
	 * @access	private
	 * @return	JCAT_Request
	 */
	private function JCAT_Request($sCLPPClassName)
	{
		JCAT_ASSERT::ASSERT_ISCLASS($sCLPPClassName,'JCAT_ICommandLineParamParser',JCAT_Language::SentenceEx('参数 $sCLPPClassName(%s) 必须实现 JCAT_ICommandLineParamParser 接口。','JCAT',null));
		
		if( self::IsHTTPRequest() )
		{
			$aCLParamParser = new $sCLPPClassName() ;
			
			$arrArgvs = self::GetCommandLineParams() ;
			$this->arrCLParams = $aCLParamParser->Parse($arrArgvs) ;			
		}
	}
	
	/**
	 * Description
	 *
	 * @access	public
	 * @static
	 * @return	JCAT_Request
	 */
	static public function GetGlobalInstance()
	{
		if( !self::$aGlobalInstance )
		{
			self::$aGlobalInstance = new JCAT_Request(self::$sDefaultCLPP) ;
		}
		return self::$aGlobalInstance ;
	}
	
	/**
	 * get user quest param
	 *
	 * @access	public
	 * @param	$sParamName		string
	 * @return	string
	 */
	public function GetParam($sParamName,$sHTTPParamType='_REQUEST')
	{
		if( self::IsHTTPRequest() )
		{
			switch ($sHTTPParamType)
			{
				
				case '_REQUEST' :
					$aParamStack =& $_REQUEST ;
					break ;
					
				case '_POST' :
					$aParamStack =& $_POST ;
					break ;
					
				case '_GET' :
					$aParamStack =& $_GET ;
					break ;
					
				case '_COOKIE' :
					$aParamStack =& $_COOKIE ;
					break ;

				default:
					
					JCAT_ASSERT::ASSERT_(0, JCAT_Language::SentenceEx("参数 \$sHTTPParamType(%s) 必须为：'_REQUEST','_POST','_GET','_COOKIE'",'JCAT',null,$sHTTPParamType)) ;
					return null ;
					break ;
			}
			
		}
		
		else 
		{
			$aParamStack =& $this->arrCLParams ;
		}

		return isset($aParamStack[$sParamName])? $aParamStack[$sParamName]: null ;
	}
	
	/**
	 * Description
	 *
	 * @access	public
	 * @static
	 * @return	bool
	 */
	static public function IsHTTPRequest()
	{
		return !empty($_SERVER['HTTP_HOST']) ;
	}
	
	/**
	 * Description
	 *
	 * @access	public
	 * @param	$sParamName='controller'		string
	 * @return	string
	 */
	public function GetRequestController($sParamName='controller')
	{
		$sControllerName = $this->GetParam($sParamName) ;
		
		if( !$sControllerName and defined($sControllerName) )
		{
			JCAT_ASSERT::ASSERT_ISCLASS(self::$sDefaultControllerClass,array('JCAT_IController')
						, "JCAT_Request::\$sDefaultControllerClass(%s) 必须是一个 JCAT_IController 类名。");
			
			$sControllerName = self::$sDefaultControllerClass ;
		}
		
		return $sControllerName ;
	}
	
	/**
	 * Description
	 *
	 * @access	public
	 * @return	JCAT_IIterator
	 */
	public function CreateParamIterator()
	{
		return new JCAT_ArrayIterator( self::IsHTTPRequest()? $_REQUEST: $this->arrCLParams ) ;
	}

	/**
	 * Description
	 *
	 * @access	public
	 * @static
	 * @return	array
	 */
	static public function GetCommandLineParams()
	{
		global $argv ;
		$arrArgvs = is_array($argv)?$argv: array() ;
		array_shift($arrArgvs) ;
		
		return array_values($arrArgvs) ;
	}
	
	/**
	 * pass user request params to a controller
	 * if current request is a http webpage, get data from http param, and just only set datas that their name in $arrDataNames
	 * if it is a desktop or a command line, get data from command line args, and datas will be renamed by $arrDataNames
	 *
	 * @access	public
	 * @param	$aController				JCAT_IController
	 * @param	$arrDataNames=array()	array
	 * @return	void
	 */
	public function PassParamsToController(JCAT_IController $aController,array $arrDataNames=array())
	{
		// webpage
		if( JCAT::$TYPE == JCAT::TYPE_HTML )
		{
			if( empty($arrDataNames) )
			{
				$arrParams =& $_REQUEST ;
			}
			else
			{
				$arrDatas = array_fill_keys($arrDataNames,null) ;
				$arrParams = array_intersect($_REQUEST,$arrDatas) ;
			}
		}
		
		// desktop or command line
		else
		{
			if( empty($arrDataNames) )
			{
				$arrParams =& $this->arrDatas ;
			}
			else
			{
				$arrArgvs = GetCommandLineParams() ;
			
				$this->arrDatas = array() ;
				$nIdx = 0 ;
				foreach ($arrDataNames as $sDataName)
				{
					$arrParams[$sDataName] = isset($arrArgvs[$nIdx])? $arrArgvs[$nIdx]: null ;
					$nIdx ++ ;
				}
			}
		}
		
		 foreach ($arrParams as $sParamName=>$sValue)
		 {
		 	$aController->SetData($sParamName,$sValue) ;
		 }
	}
	
	/**
	 * Description
	 * 
	 * @access	public
	 * @static
	 * @var		string
	 */
	static public $sDefaultCLPP = 'JCAT_CLPP_NamedParamStyle' ;
	
	
	/**
	 * Description
	 * 
	 * @access	private
	 * @static
	 * @var		JCAT_ResultDispatcher
	 */
	static private $aGlobalInstance ;
	
	/**
	 * Description
	 * 
	 * @access	private
	 * @var		array
	 */
	private $arrCLParams = array() ;
	
	/**
	 * Description
	 * @static
	 * @access	public
	 * @var		string
	 */
	static public $sDefaultControllerClass = null ;
}

?>